docs/prune: Document that --static-deltas-only isn't that useful

This is the documentation followup to: https://github.com/ostreedev/ostree/pull/1482

See also https://github.com/ostreedev/ostree/issues/1481

Closes: #1484
Approved by: jlebon

diff --git a/man/ostree-prune.xml b/man/ostree-prune.xml
index 641176ba576e758feb243f651a5b37229da2fc53..f1b517f34d392855490f513bab00c1171ada327b 100644 (file)
--- a/man/ostree-prune.xml
+++ b/man/ostree-prune.xml
@@ -114,8 +114,12 @@ Boston, MA 02111-1307, USA.
                 <term><option>--static-deltas-only</option>=DEPTH</term>
 
                 <listitem><para>
-                  Change the behaviour of --keep-younger-than and --delete-commit to prune only
-                  the static deltas files.
+                  This option may currently <emphasis>only</emphasis> be used in combination with
+                  <option>--delete-commit</option>.  Previous versions of ostree silently accepted
+                  the option without that, and ignored it.  However, there are desired use
+                  cases for pruning just static deltas (while retaining the commits), and it's
+                  likely at some point this option will be supported for use cases outside of just
+                  <option>--delete-commit</option>.
                 </para></listitem>
             </varlistentry>
         </variablelist>